ismobilejs
Advanced tools
The ismobilejs npm package is a utility library that helps in detecting if a user is accessing a website from a mobile device. It provides a simple API to determine the type of device (mobile, tablet, or desktop) and the operating system being used.
Detect if the device is mobile
This feature allows you to check if the current device is a mobile device. The 'any' property returns true if the device is a mobile device, otherwise false.
const isMobile = require('ismobilejs');
console.log(isMobile().any); // true if the device is mobile, false otherwiseDetect if the device is a tablet
This feature allows you to check if the current device is a tablet. The 'tablet' property returns true if the device is a tablet, otherwise false.
const isMobile = require('ismobilejs');
console.log(isMobile().tablet); // true if the device is a tablet, false otherwiseDetect the operating system
This feature allows you to determine the operating system of the current device. The 'os' property returns the name of the operating system.
const isMobile = require('ismobilejs');
console.log(isMobile().os); // returns the operating system of the deviceThe mobile-detect package is another utility for detecting mobile devices. It provides more detailed information about the device, including the user agent, phone model, and tablet model. Compared to ismobilejs, it offers more granular detection capabilities.
The detect-mobile-browser package is a lightweight utility for detecting mobile browsers. It is simpler than ismobilejs and focuses solely on identifying if the browser is mobile, without additional details about the device or operating system.
The ua-parser-js package is a comprehensive user-agent string parser that can detect the device type, operating system, and browser. It provides more extensive parsing capabilities compared to ismobilejs, making it suitable for more complex use cases.
A simple JS library that detects mobile devices in both the browser and NodeJS.
You might not need this library. In most cases, responsive design solves the problem of controlling how to render things across different screen sizes. I recommend a mobile first approach. But there are always edge cases. If you have an edge case, then this library might be for you.
My edge case at the time was redirecting users to a completely separate mobile site. I tried to keep this script small (currently ~1.3k bytes, minified) and simple, because it would need to execute in the <head>, which is generally a bad idea, since JS blocks the downloading and rendering of all assets while it parses and executes. In the case of mobile redirection, I don't mind so much, because I want to start the redirect as soon as possible, before the device has a chance to start downloading and rendering other stuff. For non-mobile platforms, the script should execute fast, so the browser can quickly get back to downloading and rendering.
isMobile runs quickly during initial page load to detect mobile devices; it then creates a JavaScript object with the results.
You might want to use this library to do server-side device detection to minimize the amount of bytes you send back to visitors. Or you have your own arbitrary use case.
You import and call the isMobile function, passing it a user agent string; it then returns a JavaScript object with the results.
In a browser, the following properties of the global isMobile object will either be true or false. In Node, isMobile will be whatever you named the variable.
isMobile.apple.phoneisMobile.apple.ipodisMobile.apple.tabletisMobile.apple.universalisMobile.apple.device (any mobile Apple device)isMobile.android.phoneisMobile.android.tabletisMobile.android.device (any mobile Android device; OkHttp user agents will match this)isMobile.amazon.phoneisMobile.amazon.tabletisMobile.amazon.device (any mobile Amazon Silk device)isMobile.windows.phoneisMobile.windows.tabletisMobile.windows.device (any mobile Windows device)isMobile.other.blackberry_10isMobile.other.blackberryisMobile.other.opera (Opera Mini)isMobile.other.firefoxisMobile.other.chromeisMobile.other.device (any "Other" device)isMobile.any - any device matchedisMobile.phone - any device in the 'phone' groups aboveisMobile.tablet - any device in the 'tablet' groups aboveyarn add ismobilejs
or
npm install ismobilejs
import isMobile from 'ismobilejs';
const userAgent = req.headers['user-agent'];
console.log(isMobile(userAgent).any);
Or pass in a window.navigator-shaped object that includes at least a userAgent property. To properly detect iPad on iOS 13, the object should also include the platform and maxTouchPoints properties.
// this is just an example. window.navigator is readonly in the browser
window.navigator = {
...
userAgent: 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15) AppleWebKit/605.1.15 (KHTML, like Gecko)',
platform: 'MacIntel',
maxTouchPoints: 2,
..
}
import isMobile from 'ismobilejs';
console.log(isMobile(window.navigator).apple.tablet);
A real-word example: I include the minified version of the script, inline, and at the top of the <head>. Cellular connections tend to suck, so it would be wasteful overhead to open another connection, just to download ~1.3kb of JS:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<script>
// Minified version of isMobile included in the HTML since it's small
(function () {var a={};var f=/iPhone/i,h=/iPod/i,i=/iPad/i,r=/\biOS-universal(?:.+)Mac\b/i,g=/\bAndroid(?:.+)Mobile\b/i,j=/Android/i,c=/(?:SD4930UR|\bSilk(?:.+)Mobile\b)/i,d=/Silk/i,b=/Windows Phone/i,k=/\bWindows(?:.+)ARM\b/i,m=/BlackBerry/i,n=/BB10/i,o=/Opera Mini/i,p=/\b(CriOS|Chrome)(?:.+)Mobile/i,q=/Mobile(?:.+)Firefox\b/i;function s(l){return function($){return $.test(l)}}function e(l){var $=(l=l||("undefined"!=typeof navigator?navigator.userAgent:"")).split("[FBAN");void 0!==$[1]&&(l=$[0]),void 0!==($=l.split("Twitter"))[1]&&(l=$[0]);var a=s(l),e={apple:{phone:a(f)&&!a(b),ipod:a(h),tablet:!a(f)&&a(i)&&!a(b),universal:a(r),device:(a(f)||a(h)||a(i))&&!a(b)},amazon:{phone:a(c),tablet:!a(c)&&a(d),device:a(c)||a(d)},android:{phone:!a(b)&&a(c)||!a(b)&&a(g),tablet:!a(b)&&!a(c)&&!a(g)&&(a(d)||a(j)),device:!a(b)&&(a(c)||a(d)||a(g)||a(j))||a(/\bokhttp\b/i)},windows:{phone:a(b),tablet:a(k),device:a(b)||a(k)},other:{blackberry:a(m),blackberry10:a(n),opera:a(o),firefox:a(q),chrome:a(p),device:a(m)||a(n)||a(o)||a(q)||a(p)},any:!1,phone:!1,tablet:!1};return e.any=e.apple.universal||e.apple.device||e.android.device||e.windows.device||e.other.device,e.phone=e.apple.phone||e.android.phone||e.windows.phone,e.tablet=e.apple.tablet||e.android.tablet||e.windows.tablet,e}a=e();if(typeof exports==="object"&&typeof module!=="undefined"){module.exports=a}else if(typeof define==="function"&&define.amd){define(function(){return a})}else{this["isMobile"]=a}})();
// My own arbitrary use of isMobile, as an example
(function() {
var MOBILE_SITE = '/mobile/index.html', // site to redirect to
NO_REDIRECT = 'noredirect'; // cookie to prevent redirect
// I only want to redirect iPhones, Android phones
if (isMobile.apple.phone || isMobile.android.phone) {
// Only redirect if the user didn't previously choose
// to explicitly view the full site. This is validated
// by checking if a "noredirect" cookie exists
if (document.cookie.indexOf(NO_REDIRECT) === -1) {
document.location = MOBILE_SITE;
}
}
})();
</script>
</head>
<body>
<!-- imagine lots of html and content -->
</body>
</html>
Alternatively, you can include this library via jsDelivr CDN in a script tag:
<script src="https://cdn.jsdelivr.net/npm/ismobilejs@1/dist/isMobile.min.js"></script>
Visit the isMobile jsDelivr page to get the most up-to-date URL pointing to the lastest version.
After checking out the repo, install dependencies:
yarn install
Then build the library:
yarn build
Three versions of the library will be generated:
./cjs/index.js - the CommonJS version of the library./esm/index.js - the ESModule version of the library./dist/isMobile.min.js - the browser version of the libraryAdditionally, types will be output to types.
This library uses Spotify's web-scripts project to build, lint, test, format and release the this library.
You must use yarn commit rather than git commit to commit files. This enforced commit messages to following a specific format and enables automation of release notes and version bump.
FAQs
A simple JS library that detects mobile devices.
We found that ismobilejs demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.